Conversation
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Mossaka
left a comment
There was a problem hiding this comment.
Review: REQUEST_CHANGES
@copilot Please fix the following issues:
Problem
The "Get started fast" section now only shows installation but removes the usage example entirely. A "Get started fast" section that only shows how to install - but not how to USE - the tool defeats its purpose.
What was removed that should be kept:
- The example command showing how to actually run
awfafter installation - The explanation about the
--separator (critical syntax)
Required Fix
Keep at least one usage example. A minimal but complete version:
## Get started fast
```bash
curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash
sudo awf --allow-domains github.com -- curl https://api.github.com
This keeps it terse (two lines) while showing both installation AND basic usage.
The prerequisite note about Docker can optionally be removed, but the usage example is essential.
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Added a minimal usage example and a one-sentence |
|
🎬 THE END — Smoke Claude MISSION: ACCOMPLISHED! The hero saves the day! ✨ |
|
📰 VERDICT: Smoke Copilot has concluded. All systems operational. This is a developing story. 🎤 |
Smoke Test ResultsLast 2 Merged PRs:
Tests:
Overall: PASS cc @Mossaka
|
|
Smoke Test Results for Claude Engine Last 2 merged PRs:
✅ GitHub MCP: Retrieved PR data Overall Status: PASS
|
There was a problem hiding this comment.
Pull request overview
This PR condenses the "Get started fast" section of the README to reduce verbosity while maintaining essential information. The update removes the bullet-point structure and Docker prerequisite reminder in favor of a minimal two-command code block with a brief explanation.
Changes:
- Simplified "Get started fast" section from structured bullets (Prerequisite/Install/Run) to a single code block with two commands
- Refined the
--separator explanation to be more technically precise ("divides firewall options from the command to run" instead of "passes the command you want to run behind the firewall")
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Reduce README bloat by keeping “Get started fast” terse while still showing installation and a minimal usage example.
awfusage) and add a one-sentence note explaining the--separator.curl -sSL https://raw.githubusercontent.com/github/gh-aw-firewall/main/install.sh | sudo bash sudo awf --allow-domains github.com -- curl https://api.github.comThe
--separator divides firewall options from the command to run.Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.